GetSerialNoRecord

SoftwareShield CheckPoint™ License Server > CheckPoint™ License Server Interfaces > CheckPoint_Webservice_References > GetSerialNoRecord

## GetSerialNoRecord

The GetSerialNoRecord function will retrieve a Serial number record from the checkpoint database.

###### Syntax

TRecordResponse * GetSerialNoRecord( long ASerialNoID, BSTR ASessionID, TCheckPointSNSerialRecord *& ACheckPointSNRecord ) ;

###### Parameters

ASerialNoID

[IN] This is a numeric value which represents the Serial Number id. It is used to identify which Serial Number record to retrieve.

ASessionID

[IN] This is the session ID of the logged in user.

ACheckPointSNRecord

[IN] This is a TCheckPointSNSerialRecord class which will be returned to the user. This class will contain the SerialNumber record that is retrieved. The fields of interest are:

- SNSerialsID- the license id

- CheckPointUserID - the user id of the Checkpoint User who generated the serial number. Note that this is the CheckPoint User, not the End User.

- LicenseID - The license ID that is associated with this Serial Number

- SerialNumber - The Serial Number that was generated.

- AuthDefIDNo - the Authorization Definition ID that is associated to this Serial Number

- AuthParameter - If a parameter is necessary for the Authorization Definition, then you would declare it in this field.

- TotalActivationsPermitted - the number of permitted activations allowed for the serial number

- OverflowActivationsPermitted - the number of overflows allowed for the serial number

- ActivationsConsumed - the number of activations consumed (Under regular circumstances, this should be 0)

- OrderNo- the order number that you wish to associate with this Serial Number

- Deleted - if the record was deleted

###### Remarks

The return value of this function is to verify that it was successful. The retrieved user record will be located in the out parameter ACheckPointSNRecord.

Only administrators are allowed to use this function.

###### Return Value

Returns the custom class TRecordResponse. The fields of interest that is related to this method are:

- Success- True will be returned if this function was successful, otherwise false will be returned.

- PrimaryKeyValue- the Serial Number ID of the user that is retrieved.

- ErrorMessage- if an error occurred, the associated error message can be found in this field.

###### Function Information

Exposed By Interface: | "ICheckPointService"
Exposed In ISAPI DLL: | "checkpoint.dll"